home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Internet / WWW / Perl_WWW_Utilities / makehomeidx / doc / makehomeidx.txt < prev   
Encoding:
Text File  |  1995-12-21  |  5.6 KB  |  160 lines
  1.  
  2.                                        
  3.    __________________________________________________________________________
  4.                                        
  5.                                   MAKEHOMEIDX
  6.                                        
  7.    A Perl program to generate a home pages index of all user home pages
  8.    on a machine.
  9.    
  10.    
  11.      _________________________________________________________________
  12.    
  13. Description
  14.  
  15.    makehomeidx creates an HTML file (home pages index) containing links
  16.    to users home pages on the machine makehomeidx is invoked. This
  17.    program can be executed from cron(1) to automate the adding of user's
  18.    home pages to a Web server.
  19.    
  20.    makehomeidx scans through a UNIX password file (-passwd option) and
  21.    checks each user's account if (s)he has defined a home page.
  22.    makehomeidx does the following for each user:
  23.    
  24.      * Check for the existance of a public html directory (-pubhtml
  25.        option) in the user's home directory.
  26.        
  27.      * Check for the existance of one of the following files in the
  28.        public html directory in the order listed:
  29.           + index.html
  30.           + home.html
  31.           + <user's login name>.html
  32.             
  33.      * Check for the existance of a makehomeidx resource file (-idxrc
  34.        option) in the user's public html directory. The file contains two
  35.        lines. The first line is the user's name to use in the home page
  36.        index. The second line is the user's (job) title to appear after
  37.        the user's name.
  38.        
  39.        If no resource file exists, the user's name as specified in the
  40.        UNIX password file will be used, and no job title is listed.
  41.        
  42.    The resulting home page index file lists the users with defined home
  43.    pages sorted by last name.
  44.    
  45.    See Usage for a complete list of options that affect the behavior of
  46.    makehomeidx.
  47.    
  48.    
  49.      _________________________________________________________________
  50.    
  51. Usage
  52.  
  53.    makehomeidx is invoked from a Unix shell, with the following syntax:
  54.    
  55.    % makehomeidx [options] outfile
  56.    
  57.    The resulting HTML home pages index file is specified by outfile.
  58.    
  59.    The following options are available to makehomeidx:
  60.    
  61.    -excfile filename
  62.           Use filename as the exclude file listing login names that
  63.           should be excluded in the home page index.
  64.           
  65.           Each login name must be listed on a separate line in the file.
  66.           
  67.    -footer filename
  68.           Appends the contents of filename to the home pages index
  69.           (outfile). The file may contain any HTML markup excluding the
  70.           <HTML>, <HEAD>, and <BODY> tags.
  71.           
  72.    -header filename
  73.           Prepends the contents of filename to the home pages index
  74.           (outfile). The file may contain any HTML markup excluding the
  75.           <HTML>, <HEAD>, and <BODY> tags.
  76.           
  77.    -help
  78.           Print out a short help message about makehomeidx.
  79.           
  80.    -hostname string
  81.           Use string as the name of the host machine. Otherwise, use the
  82.           string returned by hostname(1).
  83.           
  84.    -idxrc name
  85.           Use name as the filename of individuals makehomeidx resource
  86.           file. Otherwise, use ".homeidxrc".
  87.           
  88.    -incfile filename
  89.           Use filename as the include file listing login names that
  90.           should be included in the home page index. Login names not
  91.           listed, are automatically excluded in the index. This allows
  92.           you to restrict the total possible users that will be indexed.
  93.           
  94.           If a login name appears in the include file and the exclude
  95.           file specified by -excfile, then the user is excluded.
  96.           
  97.           Each login name must be listed on a separate line in the file.
  98.           
  99.    -passwd filename
  100.           Use filename as the UNIX password file. Otherwise, use
  101.           "/etc/passwd" instead. If filename is equal to "-", then
  102.           makehomeidx reads the password file from standard input. This
  103.           can be useful for password files that are accesible via NIS.
  104.           Example: ypcat passwd | makehomeidx -passwd - homepages.html
  105.           
  106.    -pubhtml name
  107.           Use name as the directory name of user's public html directory.
  108.           Otherwise, use "public_html".
  109.           
  110.    -title string
  111.           Use string for the title of the home pages index (outfile).
  112.           Otherwise, use "Home Pages".
  113.           
  114.    
  115.      _________________________________________________________________
  116.    
  117. Notes
  118.  
  119.      * The syntax of the URLs used to link to user's home page is as
  120.        follows:
  121.        
  122.        http://hostname/%7Elogin/homepage
  123.        
  124.        where,
  125.        
  126.           + hostname = machine name
  127.           + login = login name of user
  128.           + homepage = name of home page of user
  129.             
  130.    The URLs work for the NCSA http daemon. makehomeidx has only been
  131.        tested with the NCSA httpd. The author is not sure if the URLs
  132.        will work for other http daemons.
  133.        
  134.      * The UNIX passwd file is assumed to be a BSD style password file in
  135.        determining a user's real-life name. If no makehomeidx resource
  136.        file exists and no real-life name is defined in the password file,
  137.        then the user's login name is used.
  138.        
  139.      * makehomeidx requires the use of newgetopt.pl.
  140.        
  141.    
  142.      _________________________________________________________________
  143.    
  144. Author
  145.  
  146.     Earl Hood
  147.     ehood@convex.com
  148.     CONVEX Computer Corporation
  149.     3000 Waterview Parkway
  150.     P.O. Box 833851
  151.     Richardson, TX 75083-3851
  152.     
  153.     Phone: (214) 497-4387
  154.     FAX: (214) 497-4500
  155.     
  156.    
  157.      _________________________________________________________________
  158.    
  159.     makehomeidx 1.1.0
  160.